<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::sync_io::Blob_receiver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html">sync_io</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::sync_io::Blob_receiver Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A documentation-only <em>concept</em>: what <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Blob_receiver</a> is to <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Native_handle_receiver</a> (namely a degenerate version thereof), this is to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a>.  
 <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="sync__io_2blob__transport_8hpp_source.html">blob_transport.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ipc::transport::sync_io::Blob_receiver:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1sync__io_1_1Blob__receiver__coll__graph.svg" width="550" height="372"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a73f2f615f48566e32f7a974e9448f4fc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a73f2f615f48566e32f7a974e9448f4fc">Blob_receiver</a> ()</td></tr>
<tr class="memdesc:a73f2f615f48566e32f7a974e9448f4fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a73f2f615f48566e32f7a974e9448f4fc">More...</a><br /></td></tr>
<tr class="separator:a73f2f615f48566e32f7a974e9448f4fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0688815f3370c512bf44f75c3b7c9045"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a0688815f3370c512bf44f75c3b7c9045">Blob_receiver</a> (<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a0688815f3370c512bf44f75c3b7c9045"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a0688815f3370c512bf44f75c3b7c9045">More...</a><br /></td></tr>
<tr class="separator:a0688815f3370c512bf44f75c3b7c9045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b004f1d90488b41593ad03dd92498e3"><td class="memItemLeft" align="right" valign="top"><a id="a7b004f1d90488b41593ad03dd92498e3" name="a7b004f1d90488b41593ad03dd92498e3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Blob_receiver</b> (const <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;)=delete</td></tr>
<tr class="memdesc:a7b004f1d90488b41593ad03dd92498e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disallow copying. <br /></td></tr>
<tr class="separator:a7b004f1d90488b41593ad03dd92498e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d0a7f08ce20ea8515b57d78c598858"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a53d0a7f08ce20ea8515b57d78c598858">~Blob_receiver</a> ()</td></tr>
<tr class="memdesc:a53d0a7f08ce20ea8515b57d78c598858"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state, and if it's still active) and return resources to OS as applicable.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a53d0a7f08ce20ea8515b57d78c598858">More...</a><br /></td></tr>
<tr class="separator:a53d0a7f08ce20ea8515b57d78c598858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb43ada47b7cd5034eeb4a639f32141d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#acb43ada47b7cd5034eeb4a639f32141d">operator=</a> (<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:acb43ada47b7cd5034eeb4a639f32141d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#acb43ada47b7cd5034eeb4a639f32141d">More...</a><br /></td></tr>
<tr class="separator:acb43ada47b7cd5034eeb4a639f32141d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2969a9d0ddcf6b07c19a7fc4f7c34fb"><td class="memItemLeft" align="right" valign="top"><a id="ae2969a9d0ddcf6b07c19a7fc4f7c34fb" name="ae2969a9d0ddcf6b07c19a7fc4f7c34fb"></a>
<a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;)=delete</td></tr>
<tr class="memdesc:ae2969a9d0ddcf6b07c19a7fc4f7c34fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disallow copying. <br /></td></tr>
<tr class="separator:ae2969a9d0ddcf6b07c19a7fc4f7c34fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a349a3fc5bf2b0246f206ea332f8684e0"><td class="memTemplParams" colspan="2">template&lt;typename Create_ev_wait_hndl_func &gt; </td></tr>
<tr class="memitem:a349a3fc5bf2b0246f206ea332f8684e0"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a349a3fc5bf2b0246f206ea332f8684e0">replace_event_wait_handles</a> (const Create_ev_wait_hndl_func &amp;create_ev_wait_hndl_func)</td></tr>
<tr class="memdesc:a349a3fc5bf2b0246f206ea332f8684e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Coincides with <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> concept counterpart.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a349a3fc5bf2b0246f206ea332f8684e0">More...</a><br /></td></tr>
<tr class="separator:a349a3fc5bf2b0246f206ea332f8684e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af35b13d02df7b68916ba642eaf1352c3"><td class="memTemplParams" colspan="2">template&lt;typename Event_wait_func_t &gt; </td></tr>
<tr class="memitem:af35b13d02df7b68916ba642eaf1352c3"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#af35b13d02df7b68916ba642eaf1352c3">start_receive_blob_ops</a> (Event_wait_func_t &amp;&amp;ev_wait_func)</td></tr>
<tr class="memdesc:af35b13d02df7b68916ba642eaf1352c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aa55c06ebb8ba1ba262560eabadb09ab6" title="Sets up the sync_io-pattern interaction between *this and the user&#39;s event loop; required before asyn...">sync_io::Native_handle_receiver::start_receive_native_handle_ops()</a> apply.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#af35b13d02df7b68916ba642eaf1352c3">More...</a><br /></td></tr>
<tr class="separator:af35b13d02df7b68916ba642eaf1352c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8c46b25839f7660a1c867a25aa3680c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#aa8c46b25839f7660a1c867a25aa3680c">receive_blob_max_size</a> () const</td></tr>
<tr class="memdesc:aa8c46b25839f7660a1c867a25aa3680c"><td class="mdescLeft">&#160;</td><td class="mdescRight">All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a46194b54e9465a5a41d7fedf9d4982ae" title="Mirrors sync_io::Native_handle_sender::send_meta_blob_max_size().">sync_io::Native_handle_receiver::receive_meta_blob_max_size()</a> apply.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#aa8c46b25839f7660a1c867a25aa3680c">More...</a><br /></td></tr>
<tr class="separator:aa8c46b25839f7660a1c867a25aa3680c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af05f5ec0a8fd01b2056c09613a4dfc1e"><td class="memTemplParams" colspan="2">template&lt;typename Task_err_sz &gt; </td></tr>
<tr class="memitem:af05f5ec0a8fd01b2056c09613a4dfc1e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#af05f5ec0a8fd01b2056c09613a4dfc1e">async_receive_blob</a> (const <a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> &amp;target_blob, <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *sync_err_code, size_t *sync_sz, Task_err_sz &amp;&amp;on_done_func)</td></tr>
<tr class="memdesc:af05f5ec0a8fd01b2056c09613a4dfc1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Possibly-asynchronously awaits one discrete message &ndash; as sent by the opposing peer &ndash; and receives it into the given target locations, reliably and in-order.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#af05f5ec0a8fd01b2056c09613a4dfc1e">More...</a><br /></td></tr>
<tr class="separator:af05f5ec0a8fd01b2056c09613a4dfc1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6888f84e88c00d28daa579a9b47a2d77"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a6888f84e88c00d28daa579a9b47a2d77">idle_timer_run</a> (<a class="el" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout)</td></tr>
<tr class="memdesc:a6888f84e88c00d28daa579a9b47a2d77"><td class="mdescLeft">&#160;</td><td class="mdescRight">In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is, once at least the specified time has passed since the last received low-level traffic (or this call, whichever most recently occurred), to emit the pipe-hosing error <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815" title="No messages (optional auto-pings or otherwise) have been received; optionally configured timeout exce...">error::Code::S_RECEIVER_IDLE_TIMEOUT</a>.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a6888f84e88c00d28daa579a9b47a2d77">More...</a><br /></td></tr>
<tr class="separator:a6888f84e88c00d28daa579a9b47a2d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a38302b6f34d82681249da78e287cce5b"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a38302b6f34d82681249da78e287cce5b">S_RESOURCE_TYPE_ID</a></td></tr>
<tr class="memdesc:a38302b6f34d82681249da78e287cce5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same notes as for <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Blob_receiver</a>.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#a38302b6f34d82681249da78e287cce5b">More...</a><br /></td></tr>
<tr class="separator:a38302b6f34d82681249da78e287cce5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa50b1339ffe19e11a89de580a4d5d4d6"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#aa50b1339ffe19e11a89de580a4d5d4d6">S_BLOB_UNDERFLOW_ALLOWED</a> = value</td></tr>
<tr class="memdesc:aa50b1339ffe19e11a89de580a4d5d4d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same notes as for <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Blob_receiver</a>.  <a href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html#aa50b1339ffe19e11a89de580a4d5d4d6">More...</a><br /></td></tr>
<tr class="separator:aa50b1339ffe19e11a89de580a4d5d4d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A documentation-only <em>concept</em>: what <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Blob_receiver</a> is to <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Native_handle_receiver</a> (namely a degenerate version thereof), this is to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a>. </p>
<p >The concept is exactly identical to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">Native_handle_receiver</a> except that in the latter each message consists of 0-1 native handles and 0-1 binary blobs; whereas here it is always exactly 1 of the latter. More precisely, each message contains 1 binary blob, whose length must be at least 1 byte.</p>
<p >Therefore we keep the documentation very light, only pointing out the differences against <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> &ndash; which are summarized in the preceding paragraph. All other notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> apply here.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a>, an identical concept with 1 feature (native handle transmission) added. </dd></dl>

<p class="definition">Definition at line <a class="el" href="sync__io_2blob__transport_8hpp_source.html#l00203">203</a> of file <a class="el" href="sync__io_2blob__transport_8hpp_source.html">blob_transport.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a73f2f615f48566e32f7a974e9448f4fc" name="a73f2f615f48566e32f7a974e9448f4fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73f2f615f48566e32f7a974e9448f4fc">&#9670;&nbsp;</a></span>Blob_receiver() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::sync_io::Blob_receiver::Blob_receiver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default ctor: Creates a peer object in NULL (neither connected nor connecting) state. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> apply. </p>

</div>
</div>
<a id="a0688815f3370c512bf44f75c3b7c9045" name="a0688815f3370c512bf44f75c3b7c9045"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0688815f3370c512bf44f75c3b7c9045">&#9670;&nbsp;</a></span>Blob_receiver() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::sync_io::Blob_receiver::Blob_receiver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a53d0a7f08ce20ea8515b57d78c598858" name="a53d0a7f08ce20ea8515b57d78c598858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53d0a7f08ce20ea8515b57d78c598858">&#9670;&nbsp;</a></span>~Blob_receiver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ipc::transport::sync_io::Blob_receiver::~Blob_receiver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state, and if it's still active) and return resources to OS as applicable. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> apply. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af05f5ec0a8fd01b2056c09613a4dfc1e" name="af05f5ec0a8fd01b2056c09613a4dfc1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af05f5ec0a8fd01b2056c09613a4dfc1e">&#9670;&nbsp;</a></span>async_receive_blob()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Task_err_sz &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_receiver::async_receive_blob </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> &amp;&#160;</td>
          <td class="paramname"><em>target_blob</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *&#160;</td>
          <td class="paramname"><em>sync_err_code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>sync_sz</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Task_err_sz &amp;&amp;&#160;</td>
          <td class="paramname"><em>on_done_func</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Possibly-asynchronously awaits one discrete message &ndash; as sent by the opposing peer &ndash; and receives it into the given target locations, reliably and in-order. </p>
<p >Otherwise all notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6350bfb7f929a5b60fa4af1b6f7166cf" title="In PEER state: Possibly-asynchronously awaits one discrete message – as sent by the opposing peer via...">sync_io::Native_handle_receiver::async_receive_native_handle()</a> apply.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Task_err_sz</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">target_blob</td><td><code>target_blob.data()...</code> shall be written to before <code>on_done_func()</code> is executed with a falsy code, bytes numbering <code>N</code>, where <code>N</code> is passed to that callback. <code>N</code> shall not exceed <code>target_blob.size()</code>. See "Error semantics" (there is an <code>Error_code</code> regarding overflowing the user's memory area). </td></tr>
    <tr><td class="paramname">sync_err_code</td><td>See above. Do realize <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aa667487757f9d6300f6888bac40bcc24" title="A sync_io operation could not immediately complete; it will complete contingent on active async-wait ...">error::Code::S_SYNC_IO_WOULD_BLOCK</a> <em>is</em> still an error, so if this pointer is null, then would-block <em>will</em> make this throw. </td></tr>
    <tr><td class="paramname">sync_sz</td><td>See above. If null behavior undefined (assertion may trip). </td></tr>
    <tr><td class="paramname">on_done_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a6888f84e88c00d28daa579a9b47a2d77" name="a6888f84e88c00d28daa579a9b47a2d77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6888f84e88c00d28daa579a9b47a2d77">&#9670;&nbsp;</a></span>idle_timer_run()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_receiver::idle_timer_run </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a>&#160;</td>
          <td class="paramname"><em>timeout</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is, once at least the specified time has passed since the last received low-level traffic (or this call, whichever most recently occurred), to emit the pipe-hosing error <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aba920b52e9801e4927dd346ad83ce815" title="No messages (optional auto-pings or otherwise) have been received; optionally configured timeout exce...">error::Code::S_RECEIVER_IDLE_TIMEOUT</a>. </p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="acb43ada47b7cd5034eeb4a639f32141d" name="acb43ada47b7cd5034eeb4a639f32141d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb43ada47b7cd5034eeb4a639f32141d">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp; ipc::transport::sync_io::Blob_receiver::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__receiver.html">Blob_receiver</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >No-op if <code>&amp;src == this</code>.</p>
<p >All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>*this</code>. </dd></dl>

</div>
</div>
<a id="aa8c46b25839f7660a1c867a25aa3680c" name="aa8c46b25839f7660a1c867a25aa3680c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8c46b25839f7660a1c867a25aa3680c">&#9670;&nbsp;</a></span>receive_blob_max_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ipc::transport::sync_io::Blob_receiver::receive_blob_max_size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a46194b54e9465a5a41d7fedf9d4982ae" title="Mirrors sync_io::Native_handle_sender::send_meta_blob_max_size().">sync_io::Native_handle_receiver::receive_meta_blob_max_size()</a> apply. </p>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="a349a3fc5bf2b0246f206ea332f8684e0" name="a349a3fc5bf2b0246f206ea332f8684e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a349a3fc5bf2b0246f206ea332f8684e0">&#9670;&nbsp;</a></span>replace_event_wait_handles()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Create_ev_wait_hndl_func &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_receiver::replace_event_wait_handles </td>
          <td>(</td>
          <td class="paramtype">const Create_ev_wait_hndl_func &amp;&#160;</td>
          <td class="paramname"><em>create_ev_wait_hndl_func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Coincides with <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...">sync_io::Native_handle_receiver</a> concept counterpart. </p>
<p >All notes apply.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Create_ev_wait_hndl_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">create_ev_wait_hndl_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<a id="af35b13d02df7b68916ba642eaf1352c3" name="af35b13d02df7b68916ba642eaf1352c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af35b13d02df7b68916ba642eaf1352c3">&#9670;&nbsp;</a></span>start_receive_blob_ops()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Event_wait_func_t &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool ipc::transport::sync_io::Blob_receiver::start_receive_blob_ops </td>
          <td>(</td>
          <td class="paramtype">Event_wait_func_t &amp;&amp;&#160;</td>
          <td class="paramname"><em>ev_wait_func</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>All notes from <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aa55c06ebb8ba1ba262560eabadb09ab6" title="Sets up the sync_io-pattern interaction between *this and the user&#39;s event loop; required before asyn...">sync_io::Native_handle_receiver::start_receive_native_handle_ops()</a> apply. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Event_wait_func_t</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ev_wait_func</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa50b1339ffe19e11a89de580a4d5d4d6" name="aa50b1339ffe19e11a89de580a4d5d4d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa50b1339ffe19e11a89de580a4d5d4d6">&#9670;&nbsp;</a></span>S_BLOB_UNDERFLOW_ALLOWED</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr bool ipc::transport::sync_io::Blob_receiver::S_BLOB_UNDERFLOW_ALLOWED = value</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Same notes as for <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Blob_receiver</a>. </p>

<p class="definition">Definition at line <a class="el" href="sync__io_2blob__transport_8hpp_source.html#l00212">212</a> of file <a class="el" href="sync__io_2blob__transport_8hpp_source.html">blob_transport.hpp</a>.</p>

</div>
</div>
<a id="a38302b6f34d82681249da78e287cce5b" name="a38302b6f34d82681249da78e287cce5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38302b6f34d82681249da78e287cce5b">&#9670;&nbsp;</a></span>S_RESOURCE_TYPE_ID</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a> ipc::transport::sync_io::Blob_receiver::S_RESOURCE_TYPE_ID</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Same notes as for <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Blob_receiver</a>. </p>

<p class="definition">Definition at line <a class="el" href="sync__io_2blob__transport_8hpp_source.html#l00209">209</a> of file <a class="el" href="sync__io_2blob__transport_8hpp_source.html">blob_transport.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>transport/sync_io/<a class="el" href="sync__io_2blob__transport_8hpp_source.html">blob_transport.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:39 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
